List Devices


Overview

List active devices you ordered.


API Operation Object

  • Managed WAF devices

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/API/ScreenEventFGWAFDeviceGet?tenant_id={tenant_id}&locale={locale}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
item Required type format description
tenant_id yes String UUID Tenant ID of the owner (UUID)
locale no String - Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is "en".

Sample Request Body

This request does not include a request body.


Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Request format is invalid
401 Unauthorized
500 Internal Server Error
511 Internal Server Error (Fail Service Order etc.)

Response Parameter

Response Parameters
item type format description
code String - This code is for determining the details of the error.FOW-**: Successful Completion. FOW-E**: Error has occurred.
message String - This message is shown when error has occurred.
records integer - Number of devices.
rows list - Device list
cell[0] string - Internal use
cell[1] string - Rows
cell[2] string - Host Name
cell[3] string - Menu
cell[4] string - Plan
cell[5] string - Availability Zone
cell[6] string - Zone
id integer - Device ID
status integer - This value indicates normal or abnormal. 1:normal, 2:abnormal

Sample Response Body

Normal Response

When locale is "ja"

{
    "code": "FOW-01",
    "message": "正常終了",
    "records": 2,
    "rows": [{
         "cell": ["false", "1", "CES222", "WAF", "02", "zone1_groupb", ”jp1_zone1”],
         "id": 1
    },{
         "cell": ["false", "2", "CES224", "WAF", "08", "zone1_groupb", ”jp1_zone1”],
         "id": 2
    }],
    "status": 1
}

When locale is "en"
{
    "code": "FOW-01",
    "message": "Successful completion",
    "records": 2,
    "rows": [{
         "cell": ["false", "1", "CES222", "WAF", "02", "zone1_groupb", ”jp1_zone1”],
         "id": 1
    },{
         "cell": ["false", "2", "CES224", "WAF", "08", "zone1_groupb", ”jp1_zone1”],
         "id": 2
    }],
    "status": 1
}

Error Response

When locale is "ja"

{
    "code": "FOW-E",
    "message": "システムエラーが発生しました。恐れ入りますが、チケットシステムでご連絡ください。",
    "records": 0,
    "rows": [],
    "status": 2
}

When locale is "en"
{
    "code": "FOW-E",
    "message": "System error has occurred. Excuse me, please contact us at the ticket system.",
    "records": 0,
    "rows": [],
    "status": 2
}